home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / sstevx.z / sstevx
Text File  |  1996-03-14  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric tridiagonal matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSTEVX( JOBZ, RANGE, N, D, E, VL, VU, IL, IU, ABSTOL, M, W, Z,
  14.                         LDZ, WORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  27.      SSTEVX computes selected eigenvalues and, optionally, eigenvectors of a
  28.      real symmetric tridiagonal matrix A.  Eigenvalues and eigenvectors can be
  29.      selected by specifying either a range of values or a range of indices for
  30.      the desired eigenvalues.
  31.  
  32.  
  33. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  34.      JOBZ    (input) CHARACTER*1
  35.              = 'N':  Compute eigenvalues only;
  36.              = 'V':  Compute eigenvalues and eigenvectors.
  37.  
  38.      RANGE   (input) CHARACTER*1
  39.              = 'A': all eigenvalues will be found.
  40.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  41.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  42.  
  43.      N       (input) INTEGER
  44.              The order of the matrix.  N >= 0.
  45.  
  46.      D       (input/output) REAL array, dimension (N)
  47.              On entry, the n diagonal elements of the tridiagonal matrix A.
  48.              On exit, D may be multiplied by a constant factor chosen to avoid
  49.              over/underflow in computing the eigenvalues.
  50.  
  51.      E       (input/output) REAL array, dimension (N)
  52.              On entry, the (n-1) subdiagonal elements of the tridiagonal
  53.              matrix A in elements 1 to N-1 of E; E(N) need not be set.  On
  54.              exit, E may be multiplied by a constant factor chosen to avoid
  55.              over/underflow in computing the eigenvalues.
  56.  
  57.      VL      (input) REAL
  58.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  59.              the interval to be searched for eigenvalues. VL < VU.  Not
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.              referenced if RANGE = 'A' or 'I'.
  75.  
  76.      IL      (input) INTEGER
  77.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  78.              order) of the smallest and largest eigenvalues to be returned.  1
  79.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  80.              referenced if RANGE = 'A' or 'V'.
  81.  
  82.      ABSTOL  (input) REAL
  83.              The absolute error tolerance for the eigenvalues.  An approximate
  84.              eigenvalue is accepted as converged when it is determined to lie
  85.              in an interval [a,b] of width less than or equal to
  86.  
  87.              ABSTOL + EPS *   max( |a|,|b| ) ,
  88.  
  89.              where EPS is the machine precision.  If ABSTOL is less than or
  90.              equal to zero, then  EPS*|T|  will be used in its place, where
  91.              |T| is the 1-norm of the tridiagonal matrix.
  92.  
  93.              Eigenvalues will be computed most accurately when ABSTOL is set
  94.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  95.              this routine returns with INFO>0, indicating that some
  96.              eigenvectors did not converge, try setting ABSTOL to
  97.              2*SLAMCH('S').
  98.  
  99.              See "Computing Small Singular Values of Bidiagonal Matrices with
  100.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  101.              Working Note #3.
  102.  
  103.      M       (output) INTEGER
  104.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  105.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  106.  
  107.      W       (output) REAL array, dimension (N)
  108.              The first M elements contain the selected eigenvalues in
  109.              ascending order.
  110.  
  111.      Z       (output) REAL array, dimension (LDZ, max(1,M) )
  112.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  113.              the orthonormal eigenvectors of the matrix A corresponding to the
  114.              selected eigenvalues, with the i-th column of Z holding the
  115.              eigenvector associated with W(i).  If an eigenvector fails to
  116.              converge (INFO > 0), then that column of Z contains the latest
  117.              approximation to the eigenvector, and the index of the
  118.              eigenvector is returned in IFAIL.  If JOBZ = 'N', then Z is not
  119.              referenced.  Note: the user must ensure that at least max(1,M)
  120.              columns are supplied in the array Z; if RANGE = 'V', the exact
  121.              value of M is not known in advance and an upper bound must be
  122.              used.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      LDZ     (input) INTEGER
  141.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  142.              'V', LDZ >= max(1,N).
  143.  
  144.      WORK    (workspace) REAL array, dimension (5*N)
  145.  
  146.      IWORK   (workspace) INTEGER array, dimension (5*N)
  147.  
  148.      IFAIL   (output) INTEGER array, dimension (N)
  149.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  150.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  151.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  152.              is not referenced.
  153.  
  154.      INFO    (output) INTEGER
  155.              = 0:  successful exit
  156.              < 0:  if INFO = -i, the i-th argument had an illegal value
  157.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  158.              indices are stored in array IFAIL.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.